fix: allow clientSecretCertificateKeyVaultReference in AAD auth schema (#944)#993
Open
LongOddCode wants to merge 1 commit intoAzure:mainfrom
Open
fix: allow clientSecretCertificateKeyVaultReference in AAD auth schema (#944)#993LongOddCode wants to merge 1 commit intoAzure:mainfrom
LongOddCode wants to merge 1 commit intoAzure:mainfrom
Conversation
Azure#944) The staticwebapp.config.json schema for azureActiveDirectory.registration required clientSecretSettingName and did not allow clientSecretCertificateKeyVaultReference, causing 'swa deploy' to reject the documented cert-based auth shape (see Microsoft Learn: Custom authentication in Azure Static Web Apps). Changes: - Add clientSecretCertificateKeyVaultReference property. - Remove clientSecretSettingName from unconditional 'required'. - Add oneOf requiring exactly one of the two credentials, so validation still enforces that a credential is configured. Guidance from @Timothyw0 on the issue pointed to this exact schema location.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Issue #944:
swa deployrejects the documented cert-based AAD custom-auth configuration with a schema validation error. The shape is published on Microsoft Learn (Custom authentication in Azure Static Web Apps) and usesclientSecretCertificateKeyVaultReference, but the CLI'sstaticwebapp.config.jsonschema does not allow it.Root Cause
In
schema/staticwebapp.config.jsontheazureActiveDirectory.registrationobject:clientSecretSettingNameas unconditionallyrequired.clientSecretCertificateKeyVaultReferenceas an allowed property, soadditionalProperties: falserejects it.Both conditions together make the cert-based shape invalid. Maintainer @Timothyw0 confirmed on the issue that this exact file + line is where the change belongs.
Fix
schema/staticwebapp.config.jsonclientSecretCertificateKeyVaultReferenceproperty; relaxrequiredto["openIdIssuer"]; addoneOfthat requires exactly one ofclientSecretSettingNameorclientSecretCertificateKeyVaultReference.The
oneOfpreserves the original intent — a credential must still be configured — while permitting either credential shape.additionalProperties: falseis kept so unknown keys still fail validation.Testing
clientSecretSettingNamestill validates (covered byoneOfbranch 1).clientSecretCertificateKeyVaultReferencenow validates (covered byoneOfbranch 2).clientSecretSettingNamedescription was extended to clarify mutual exclusion.References